
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Contribute &#8212; PixieDust Documentation</title>
    <link rel="stylesheet" href="_static/better.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/custom.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '1.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="shortcut icon" href="_static/pd_icon.ico"/>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Write a new PixieDust Visualization" href="writeviz.html" />
    <link rel="prev" title="Develop for PixieDust" href="develop.html" />
  <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
  </head>
  <body>
    <header id="pageheader"><h1><a href="index.html ">
        PixieDust Documentation
    </a></h1></header>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="contribute">
<h1>Contribute<a class="headerlink" href="#contribute" title="Permalink to this headline">¶</a></h1>
<p>PixieDust is under active development and welcomes contributions and participations from all individuals regardless of skill level. Whether you like to review documentation or implement new features, there’s a lot you can do.</p>
<div class="section" id="create-an-issue">
<h2>Create an Issue<a class="headerlink" href="#create-an-issue" title="Permalink to this headline">¶</a></h2>
<p>Create an issue if you find:</p>
<ul class="simple">
<li>any problems that you are unable to fix</li>
<li>documentation that’s hard to follow</li>
<li>inconsistencies in code, user interface, or documentation</li>
</ul>
<p>You can create issues in the <a class="reference external" href="https://github.com/ibm-cds-labs/pixiedust/issues">PixieDust GitHub repository</a>. To minimize duplicates, please review exising issues and search for your problem before creating a new issue.</p>
</div>
<div class="section" id="create-a-pull-request">
<h2>Create a Pull Request<a class="headerlink" href="#create-a-pull-request" title="Permalink to this headline">¶</a></h2>
<p>If you’re pitching in and fixed an issue or added a new feature (bravo!) please submit a <a class="reference external" href="https://github.com/ibm-cds-labs/pixiedust/pulls">pull request</a>. All pull requests are welcome and will be reviewed by the PixieDust maintainers before being accepted/merged.</p>
<p>If you’re new to GitHub or unfamiliar with pull requests, watch the <a class="reference external" href="https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github">How to Contribute to an Open Source Project on GitHub</a>  video series.</p>
<p>Here are the steps for working with the <a class="reference external" href="https://github.com/ibm-cds-labs/pixiedust/issues">PixieDust GitHub repository</a>. (These instructs assume you have PixieDust set up and are ready to <a class="reference external" href="develop.html">start development</a>).</p>
<ol class="arabic simple">
<li>If you haven’t already, <a class="reference external" href="https://guides.github.com/activities/forking/">fork</a> the PixieDust repository.</li>
<li>Create a <a class="reference external" href="http://guides.github.com/introduction/flow/">branch</a> for your changes.</li>
<li>Make the edits in your branch.</li>
<li><a class="reference external" href="test.html">Test</a> to make sure your changes do not break existing behavior.</li>
<li>Repeat steps 3 and 4 until you are ready to submit your updates.</li>
<li><a class="reference external" href="https://help.github.com/articles/creating-a-pull-request/">Submit a pull request</a>.</li>
</ol>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">While you work, regularly pull in changes from the PixieDust ‘master’ stream so you stay up-to-date and minimize merge conflicts when you submit your pull request. <a class="reference external" href="https://help.github.com/articles/syncing-a-fork">See detailed instructions</a>.</p>
</div>
</div>
<div class="section" id="where-we-need-help">
<h2>Where we need help<a class="headerlink" href="#where-we-need-help" title="Permalink to this headline">¶</a></h2>
<p>Here are the visualizations and renderers we have so far:</p>
<table width="96%">
<tr>
<td style="border-bottom: 1px solid gray;">&nbsp;</td>
<td style="border-bottom: 1px solid gray;"><strong>Bar Chart</strong></td>
<td style="border-bottom: 1px solid gray;"><strong>Pie Chart</strong></td>
<td style="border-bottom: 1px solid gray;"><strong>Line Graph</strong></td>
<td style="border-bottom: 1px solid gray;"><strong>Scatter Plot</strong></td>
 <td style="border-bottom: 1px solid gray;"><strong>Histogram</strong></td>
<td style="border-bottom: 1px solid gray;"><strong>Map</strong></td>
</tr>
<tr>
<td>matplotlib</td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>

</tr>
<tr>
<td>Seaborn</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>
<td>NA</td>

</tr>
<tr>
<td>Bokeh</td>
<td><img src="_images/chmk.png"></td>
<td>&nbsp;</td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>
<td><img src="_images/chmk.png"></td>
<td>NA</td>

</tr>
<tr>
<td>MapBox</td>
<td>NA</td>
<td>NA</td>
<td>NA</td>
<td>NA</td>
<td>NA</td>
<td><img src="_images/chmk.png"></td>

</tr>
<tr>
<td>Google Maps</td>
<td>NA</td>
<td>NA</td>
<td>NA</td>
<td>NA</td>
<td>NA</td>
<td><img src="_images/chmk.png"></td>
</tr>
</table><p>Choose a project, pitch in, and help us complete every component here. Or come up with your own enhancement. Let us know. We’d love to see your work.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="use.html">Use PixieDust</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="develop.html">Develop for PixieDust</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Contribute</a></li>
<li class="toctree-l2"><a class="reference internal" href="writeviz.html">Write a new PixieDust Visualization</a></li>
<li class="toctree-l2"><a class="reference internal" href="renderer.html">Build a Renderer</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pixieapps.html">PixieApps</a></li>
<li class="toctree-l1"><a class="reference internal" href="pixiegateway.html">PixieGateway</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasenotes.html">Release Notes</a></li>
</ul>

<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
  <footer id="pagefooter">&copy; 2017, IBM.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a>
      1.6.3.

  </footer>

  
  </body>
</html>